Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Linea smart contract docs #903

Merged
merged 15 commits into from
Dec 19, 2024
Merged

Conversation

kyzooghost
Copy link
Collaborator

No description provided.

Copy link

vercel bot commented Dec 17, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
doc-zk-evm ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 19, 2024 11:22am

Copy link
Collaborator

@jlwllmr jlwllmr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just the one suggestion for now! We use sentence case for all headings.

I'm seeing if there's a way we can get the case.yml workflow to ignore the paths so it passes the checks on the PR.

Other asks:

  • Is there a way we can use US English? I noticed this seems to use non-US spelling, and we stick to US spelling for consistency
  • Ideally, a lot of the titles, headings and subheadings would be in backticks/formatted as inline code. All function parameters and anything referencing code probably should be too -- see existing reference pages for an example. Do you know if we can enforce this? I don't think it's a dealbreaker, but it would look better and improve clarity.

sidebars.js Outdated Show resolved Hide resolved
Co-authored-by: Joel Willmore <[email protected]>
@kyzooghost
Copy link
Collaborator Author

Just the one suggestion for now! We use sentence case for all headings.

I'm seeing if there's a way we can get the case.yml workflow to ignore the paths so it passes the checks on the PR.

Other asks:

  • Is there a way we can use US English? I noticed this seems to use non-US spelling, and we stick to US spelling for consistency
  • Ideally, a lot of the titles, headings and subheadings would be in backticks/formatted as inline code. All function parameters and anything referencing code probably should be too -- see existing reference pages for an example. Do you know if we can enforce this? I don't think it's a dealbreaker, but it would look better and improve clarity.

Re: case.yml workflow - I can do something there

Re: titles, headings and subheadings formatting - Should be doable in the templates, let me see what I can do

Re: US English spelling - Mind if I create another ticket to do that for another PR?

@jlwllmr
Copy link
Collaborator

jlwllmr commented Dec 18, 2024

Thanks! re the US English -- yes, addressing that later will be fine

Copy link
Collaborator

@jlwllmr jlwllmr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🫡

@jlwllmr jlwllmr merged commit d0f7dd1 into main Dec 19, 2024
9 of 10 checks passed
@jlwllmr jlwllmr deleted the update-linea-smart-contract-docs branch December 19, 2024 11:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants